home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d2 / qflist11.arc / QFLIST.DOC < prev    next >
Text File  |  1989-09-05  |  23KB  |  526 lines
  1.  
  2.  
  3.            
  4.            
  5.            
  6.            
  7.            
  8.            
  9.            
  10.            
  11.            
  12.                               --------------------------
  13.  
  14.                                         QFLIST
  15.  
  16.                                     USERS' MANUAL
  17.  
  18.                               --------------------------
  19.                                            
  20.                                            
  21.                                            
  22.                                    A User-Supported
  23.                                  File Browse Utility
  24.                                  written by Kenn Flee
  25.                                           of
  26.                                   Jamestown Software
  27.                                2508 Valley Forge Drive
  28.                                    Madison WI 53719
  29.                                            
  30.                                            
  31.                                            
  32.                                            
  33.                             Version 1.1  - August 29, 1989
  34.  
  35.  
  36.  
  37.  
  38.                                            
  39.                                            
  40.                                            
  41.                        Copyright (c) 1989 by Jamestown Software
  42.  
  43.  
  44.  
  45.           Jamestown Software will not be liable  for any damages, including
  46.           lost profits, lost  savings or other incidental  or consequential
  47.           damages arising out  of the use  of or  inability to use  QFLIST,
  48.           even if Jamestown Software has been advised of the possibility of
  49.           such damages, or for any claim by any other party. 
  50.           Page 2                                              QFLIST Manual
  51.  
  52.  
  53.                                   TABLE OF CONTENTS
  54.                                  -------------------
  55.  
  56.                     Introduction and credit   . . . . . .  page 3
  57.  
  58.                     Description of use  . . . . . . . . .  page 3
  59.  
  60.                        Getting Started  . . . . . . . . .  page 3
  61.  
  62.                        Text vs. Binary Files  . . . . . .  page 4
  63.  
  64.                        Screen Layout  . . . . . . . . . .  page 4
  65.  
  66.                        Information Line   . . . . . . . .  page 5
  67.  
  68.                        Status Line  . . . . . . . . . . .  page 5
  69.  
  70.                        Screen Colors  . . . . . . . . . .  page 6
  71.  
  72.                        Finding Text   . . . . . . . . . .  page 6
  73.  
  74.                        Printing   . . . . . . . . . . . .  page 7
  75.  
  76.                        Saving a Config File   . . . . . .  page 7
  77.  
  78.                     Commands and Keys   . . . . . . . . .  page 8
  79.  
  80.                        Cursor keys  . . . . . . . . . . .  page 8
  81.  
  82.                        Function keys  . . . . . . . . . .  page 8
  83.  
  84.                        Alt keys   . . . . . . . . . . . .  page 8
  85.  
  86.                        Letter keys  . . . . . . . . . . .  page 9
  87.  
  88.                     Miscellaneous   . . . . . . . . . .   page 10
  89.  
  90.                     User Support Software   . . . . . .   page 11
  91.  
  92.                     Invoice / Registration  . . . . . .   page 12
  93.           QFLIST Manual                                              Page 3
  94.  
  95.                                INTRODUCTION AND CREDIT
  96.                               -------------------------
  97.  
  98.           QFLIST  is a  file  browse utility  modeled  after the  excellent
  99.           user-supported  LIST.COM  program   by  Vernon  D.  Buerg,   (456
  100.           Lakeshire, Daly City, CA 94015). However, QFLIST supports  only a
  101.           subset  of  the many  options  offered  by LIST  and  is intended
  102.           primarily for use  with QFILER (a  popular DOS file manager)  and
  103.           QFMENU (a menu system), both by Jamestown Software. 
  104.  
  105.           QFLIST may also be run as a stand-alone utility and allows you to
  106.           select the file  you wish to view from a sorted list of available
  107.           files -- including  the ability to change  drives and directories
  108.           from within QFLIST.
  109.  
  110.  
  111.  
  112.                                   DESCRIPTION OF USE
  113.                                  --------------------
  114.  
  115.           Getting Started
  116.           ---------------
  117.  
  118.           USAGE:  QFLIST [drive:][path][filename]
  119.  
  120.           QFLIST is used to view or browse the contents of a file, allowing
  121.           for scrolling  and positioning  within the  file. To  use QFLIST,
  122.           just type  the command QFLIST at the  DOS prompt, followed by the
  123.           name of the file you wish to  see.  For example:
  124.  
  125.                QFLIST QFLIST.DOC 
  126.  
  127.           would display this file.
  128.  
  129.           Use of the filename  is optional. If you simply type  the command
  130.           QFLIST  at the DOS prompt, you  are prompted to enter a filename.
  131.           You may then just press enter without entering a filename, or may
  132.           enter a  path  with  wildcards. An  alphabetical  list  of  files
  133.           matching your entry will be displayed. 
  134.  
  135.           When  the  available files  are listed,  use  the cursor  keys to
  136.           select the  file you wish to view.  Optionally, you may press the
  137.           first  letter  of  the  desired  file  and  the  cursor  will  be
  138.           positioned on the first entry starting with that letter.
  139.  
  140.           Once  the  selected file  is displayed,  you  may use  the cursor
  141.           positioning keys to view different parts of the file. The file is
  142.           displayed in "pages" of 23 lines. To see the next page, press the
  143.           PgDn key.  The PgUp  key moves  back one page,  the up-arrow  and
  144.           down-arrow keys move  one line at a  time, the home key  moves to
  145.           beginning of  the file and  the end key  moves to the  end of the
  146.           file. When you  are done, press the  ESCape key to return  to the
  147.           DOS prompt.           Page 4                                              QFLIST Manual
  148.  
  149.           You may  rename QFLIST  to any  convenient name,  such as  V.EXE,
  150.           READ.EXE or LIST.EXE. If you are  using a QFILER version 3.1HD or
  151.           older, you must  rename QFLIST.EXE to  LIST.EXE for QFILER to  be
  152.           able to recognize the program and link to it.
  153.  
  154.  
  155.           Text vs Binary Files
  156.           --------------------
  157.  
  158.           QFLIST may  be used  to view both  text files  and binary  files.
  159.           Text files are those which contain  text (such as this QFLIST.DOC
  160.           file) and not  binary or control  codes. Text characters  usually
  161.           range from a value of 32 through 127. Binary files, such as those
  162.           with the extension .COM and .EXE,  have characters ranging from 0
  163.           through 255 and may be viewed conveniently by pressing alt-H, the
  164.           hex dump display command.
  165.  
  166.           Characters below the space character 32 and characters above  127
  167.           (graphic  characters) are  displayed  if the  "8"  command is  in
  168.           effect. To filter out these normally non-text characters, use the
  169.           "7" command.
  170.  
  171.  
  172.           Screen Layout
  173.           ------------- 
  174.  
  175.           The top, or  information line of  the QFLIST screen displays  the
  176.           file name, file  creation time and date, top line number and left
  177.           offset. The  bottom, or status line  shows the file size  and the
  178.           status of various options. The middle section between the top and
  179.           bottom lines, or display  window, shows 23 lines of  the selected
  180.           file.
  181.  
  182.           If you have an EGA  or VGA monitor, you may use the alt-E command
  183.           to change to  EGA 43-line or VGA 50-line mode.  Press alt-E again
  184.           to return to the standard 25-line mode.
  185.  
  186.           Each line  that is displayed either ends in a  line feed or has a
  187.           length of 1024  characters, whichever comes  first. If a line  is
  188.           not fully  shown, you may press  the cursor right and  left arrow
  189.           keys to scroll right and left.
  190.           QFLIST Manual                                              Page 5
  191.  
  192.           Information Line
  193.           ----------------
  194.  
  195.           The top information line has the following format:
  196.  
  197.                QFLIST  llll  nnnn  mmmm  fileinfo
  198.  
  199.           where:
  200.  
  201.           QFLIST    is name of the program
  202.  
  203.           "llll"    is  the  line number  of the  first  line shown  in the
  204.                     display window
  205.  
  206.           "nnnn"    is the total number of lines in the file
  207.  
  208.           "mmmm"    is the left  offset, or number  of characters you  have
  209.                     scrolled right.
  210.  
  211.           fileinfo  is either  the file  name and  extension with  creation
  212.                     time and date,  or optionally (with the  alt-A command)
  213.                     the full path name of the displayed file.
  214.  
  215.  
  216.           Status Line
  217.           -----------
  218.  
  219.           The bottom status line has the format
  220.  
  221.                message  F1=help  X=exit  Options: ?????  nnnn bytes
  222.  
  223.           where "message" can  be a  command prompt  "Find?", displayed  in
  224.           response to  the F9 or  F command, where  you are being  asked to
  225.           enter the text you wish to find, or a status message:
  226.  
  227.           "*** Text not found ***" - your text was not found
  228.           "*** Top-of-file ***" - first line of the file is being displayed
  229.           "*** End-of-file ***" - last line of the file is being displayed
  230.  
  231.           "Options" show the status of toggles -- capital letter means on:
  232.  
  233.             "A" means the alternate file display is active (alt-A)
  234.             "H" means the hex display mode is active (alt-H)
  235.             "P" means that print is active (P)
  236.             "T" means tab characters are expanded (alt-T)
  237.             "7/8" means 7- or 8-bit display is active (7 or 8)
  238.  
  239.           "nnnn" is the size of the file displayed.
  240.           Page 6                                              QFLIST Manual
  241.  
  242.           Screen Colors
  243.           -------------
  244.  
  245.           There are three colors used by QFLIST:
  246.              - for the top information and bottom status lines (1/25)
  247.              - for the text in the middle display window
  248.              - a "highlight" color for lines containing "find" text
  249.  
  250.           There are a  pair of function keys assigned to change each of the
  251.           colors.  One of the function key changes the background color and
  252.           the other function key changes the foreground or character color.
  253.  
  254.           Colors may  be changed  with the  use of  the following  function
  255.           keys:
  256.  
  257.              Top information and bottom status lines:
  258.                     F7 - background color
  259.                     F8 - character color
  260.  
  261.              Text in the middle display window:
  262.                     F5 - background color
  263.                     F6 - character color
  264.  
  265.              Highlight for "find" text:
  266.                     F3 - background color
  267.                     F4 - character color
  268.  
  269.           If you wish to make the color changes permanent, you may  use the
  270.           alt-C configuration command to save your choices.
  271.  
  272.  
  273.           Finding Text
  274.           ------------
  275.  
  276.           If you wish to locate a character string, you may use the F9 or F
  277.           "Find new text" command, followed with one or more characters you
  278.           wish to find within the file.
  279.  
  280.           While QFLIST is scanning the file for the text, the bottom status
  281.           line will display "Searching for ????". If the text is found, the
  282.           line containing it will be displayed in the "highlight" color. If
  283.           it is not found, the bottom  status line will read "*** Text  not
  284.           found ***".  Pressing  any key will redisplay the  normal  bottom
  285.           status line.
  286.  
  287.           To find the next occurrence of  the same text, you may use the  A
  288.           or F10 "Find text again" command.
  289.           QFLIST Manual                                              Page 7
  290.  
  291.           Printing
  292.           --------
  293.  
  294.           The file may be printed as it is displayed. The P command toggles
  295.           the default printer on or off. When first  entered, the P command
  296.           causes  the  current  screen to  be  printed.  As  new lines  are
  297.           displayed,  they are  also printed.  Printing  may be  stopped by
  298.           entering a second P command.
  299.  
  300.  
  301.           Saving a Config File
  302.           --------------------
  303.  
  304.           If you wish to "permanently" save  QFLIST's current screen colors
  305.           and other options,  you may use  the alt-C "save current  config"
  306.           command. For this command to function properly, QFLIST must be in
  307.           a pathed  subdirectory. In other words, if  you enter PATH at the
  308.           DOS prompt, the subdirectory  in which QFLIST is located  must be
  309.           listed.  The  list of  pathed  subdirectories  is set  up  with a
  310.           "PATH=" entry in  your AUTOEXEC.BAT file and is read  by DOS when
  311.           your computer is first turned on.
  312.  
  313.           If the QFLIST subdirectory  is located, the current  options will
  314.           be saved in a configuration file  named QFLIST.CFG, which will be
  315.           located in the same directory as QFLIST.EXE.
  316.  
  317.           The options that are saved are:
  318.  
  319.              - The current screen colors
  320.              - alt-A alternate file name display
  321.              - alt-E EGA/VGA mode switch
  322.              - alt-H hex file display mode, like the DEBUG format
  323.              - alt-T tab character expansion
  324.              - 7/8 7-bit or 8-bit display mode
  325.  
  326.           You should save a config file before renaming QFLIST.EXE.
  327.           Page 8                                              QFLIST Manual
  328.  
  329.                                   COMMANDS AND KEYS
  330.                                  -------------------
  331.  
  332.           Cursor key     Function
  333.           -------------  -------------------------------------------------
  334.           up arrow       up one (previous) line
  335.           down arrow     down one (next) line
  336.           left arrow     scroll left 10 columns
  337.           right arrow    scroll right 10 columns
  338.           PgUp           scroll up one page
  339.           PgDn           scroll down one page
  340.           HOME           position to first line, left offset 0 (top)
  341.           END            position to end of file (bottom)
  342.           ctrl-left      set left offset to 0
  343.  
  344.           Function key   Function
  345.           -------------  -------------------------------------------------
  346.           F1             Help - display summary of commands
  347.           F2             Exit to DOS
  348.  
  349.           F3             change background color for FIND text
  350.           F4             change character color for FIND text
  351.  
  352.           F5             change background color for top and bottom lines
  353.           F6             change character color for top and bottom lines
  354.  
  355.           F7             change background color for main text window
  356.           F8             change character color for main text window
  357.  
  358.           F9             Find new text
  359.           F10            Find next occurrence of text
  360.  
  361.           Alt key        Function
  362.           -------------  -------------------------------------------------
  363.           alt-A          toggle filename display on top information line
  364.           alt-C          save current options in a configuration file
  365.           alt-E          toggle EGA 43-line or VGA 50-line mode
  366.           alt-H          toggle HEX display mode (for binary files)
  367.           alt-T          toggle tab expansion mode
  368.           QFLIST Manual                                              Page 9
  369.  
  370.                                   COMMANDS AND KEYS (continued)
  371.                                  -------------------------------
  372.  
  373.           Letter key     Function
  374.           -------------  -------------------------------------------------
  375.           A              Find next occurrence of text
  376.           F              Find new text
  377.           H              Help - display summary of commands
  378.           N              Get new file
  379.           P              Toggle printing
  380.           X              Exit to DOS
  381.  
  382.           T              Position to first line, left offset 0 (top)
  383.           B              Position to end of file (bottom)
  384.           D              Down one (next) line
  385.           U              Up one (previous) line
  386.  
  387.           7              Strip hi-bit - don't show graphic characters
  388.           8              Leave hi-bit - show all characters
  389.  
  390.  
  391.  
  392.                                      LIMITATIONS
  393.                                     -------------
  394.  
  395.           QFLIST uses as much memory as is available to store both the text
  396.           itself and information  about the displayed file.  If there isn't
  397.           enough  memory  to  perform the  minimum  functions,  QFLIST will
  398.           terminate with an error message.
  399.  
  400.           Files larger  than available memory  can be displayed.   However,
  401.           files displayed in text  mode can have no more than  10,000 lines
  402.           and files displayed in hex mode can be no larger than just over 1
  403.           megabyte (1,000,000 bytes).
  404.  
  405.           QFLIST first scans the file to locate the beginning of each line,
  406.           then stores several "chunks" of the file in memory. If you scroll
  407.           into an area of the file that  is not currently stored in memory,
  408.           QFLIST will pause briefly to read another "chunk" of the file and
  409.           store it in place of the least recently viewed chunk.
  410.           Page 10                                             QFLIST Manual
  411.  
  412.                                     MISCELLANEOUS 
  413.                                    --------------- 
  414.            
  415.           QFLIST  is a  very  simple alternate  to  Vern Buerg's  excellent
  416.           LIST.COM utility. If  you are  a "power" user,  get and  register
  417.           Buerg's  LIST.  Buerg's   LIST.COM  is   small,  fast  and   very
  418.           affordable,  with  a suggested  registration  amount of  only $15
  419.           (Vernon D. Buerg, 456 Lakeshire, Daly City, CA 94015). 
  420.  
  421.           If you want  something a little  simpler, with fewer options  but
  422.           allowing the selection of  files from a list of  available files,
  423.           try QFLIST. QFLIST is a good choice for novice users.
  424.  
  425.           QFLIST was developed  primarily to work  with QFILER.   QFILER (a
  426.           popular DOS  file manager from Jamestown Software)  can interface
  427.           with both Buerg's LIST and Jamestown's QFLIST. If you are using a
  428.           version of QFILER  that has a  version number of 3.1HD  or older,
  429.           you must rename  QFLIST.EXE to LIST.EXE  so that QFILER can  find
  430.           it. Be  sure to save a config file  before renaming QFLIST if you
  431.           prefer different screen colors and so on.
  432.            
  433.           If  you  wish additional  features to  be  included in  QFLIST or
  434.           QFILER,  if  you  discover any  program  errors  (write down  any
  435.           numbers displayed on the  screen), or if you wish  information on
  436.           quantity purchases please contact: 
  437.            
  438.           Kenn Flee
  439.           Jamestown Software
  440.           2508 Valley Forge Drive
  441.           Madison WI 53719
  442.            
  443.           Voice: 608-271-2090
  444.            
  445.           Compuserve # 74275,745
  446.            
  447.           BBS: 608-271-3685
  448.           (Public Technical Support Node)
  449.           (24 Hr., 300-1200-2400, 8-N-1, no nulls)
  450.           QFLIST Manual                                             Page 11
  451.  
  452.                                USER SUPPORTED SOFTWARE 
  453.                               ------------------------- 
  454.            
  455.           This program  is distributed for  personal, private use  and with
  456.           the understanding that  if it is used  and found to be  of value,
  457.           the user will  register with a  contribution of $15. This  action
  458.           will be appreciated and will  encourage further development. Upon
  459.           receipt of registration, a  disk with the most recent  version of
  460.           the registered  program(s), plus appropriate  supporting programs
  461.           will be mailed to the user. 
  462.            
  463.           Commercial and corporate use without  registration and license is
  464.           prohibited. 
  465.            
  466.           In any case, copy the program and share it with others. 
  467.            
  468.           For  the convenience  of corporate  users and  others,  a printed
  469.           invoice is included on the next page. 
  470.  
  471.                             ------------------------------
  472.                                 INVOICE / REGISTRATION
  473.                             ------------------------------
  474.                                            
  475.                                   JAMESTOWN SOFTWARE
  476.                                2508 Valley Forge Drive
  477.                                    Madison WI 53719
  478.            
  479.            
  480.           Sold to: ___________________________________________________ 
  481.  
  482.                    ___________________________________________________ 
  483.            
  484.                    ___________________________________________________ 
  485.            
  486.            
  487.              Date: ______________________________ 
  488.  
  489.            
  490.           =================================================================
  491.  
  492.  
  493.             _____ copies of QFLIST 1.1 at $15 each ....... $____________ 
  494.            
  495.             _____ copies of newest QFILER at $20 each ....  ____________ 
  496.  
  497.             _____ copies of newest QFMENU at $20 each ....  ____________
  498.  
  499.           Special bundled prices:
  500.  
  501.             _____ copies of QFLIST+QFILER at $30  ........  ____________ 
  502.  
  503.             _____ copies of QFLIST+QFILER+QFMENU at $45 ..  ____________
  504.            
  505.             _____ 3.5" disk (in place of 5.25") at $3 each  ____________ 
  506.             
  507.                   Wisconsin residents add 5% Sales Tax ...  ____________ 
  508.  
  509.            
  510.                                      TOTAL ENCLOSED....... $____________ 
  511.  
  512.            
  513.                          Send this invoice and your check to:
  514.  
  515.                                   Jamestown Software
  516.                                2508 Valley Forge Drive
  517.                                    Madison WI 53719 
  518.            
  519.            
  520.           =================================================================
  521.            
  522.             Thank you for your support ............... Jamestown Software 
  523.            
  524.               For a large number of QFILER packages, contact Jamestown 
  525.                   Software for site licensing or quantity pricing. 
  526.